Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: DLT-1797 move SB to docs - Popover to Root Layout #5

Open
wants to merge 4 commits into
base: staging
Choose a base branch
from

Conversation

lizard-boy
Copy link

PR Title

Obligatory GIF (super important!)

Obligatory GIF

๐Ÿ› ๏ธ Type Of Change

These types will increment the version number on release:

  • Fix
  • Feature
  • Performance Improvement
  • Refactor

These types will not increment the version number, but will still deploy to documentation site on release:

  • Documentation
  • Build system
  • CI
  • Style (code style changes, not css changes)
  • Test
  • Other (chore)

๐Ÿ“– Jira Ticket

DLT-1797

๐Ÿ“– Description

๐Ÿ’ก Context

๐Ÿ“ Checklist

For all PRs:

  • I have ensured no private Dialpad links or info are in the code or pull request description (Dialtone is a public repo!).
  • I have reviewed my changes.
  • I have added all relevant documentation.
  • I have considered the performance impact of my change.

For all Vue changes:

  • I have added / updated unit tests.
  • I have made my changes in Vue 2 and Vue 3. Note: you may sync your changes from Vue 2 to Vue 3 (or vice versa) using the ./scripts/dialtone-vue-sync.sh script. Read docs here: Dialtone Vue Sync Script
  • I have validated components with a screen reader.
  • I have validated components keyboard navigation.

For all CSS changes:

  • I have used design tokens whenever possible.
  • I have considered how this change will behave on different screen sizes.
  • I have visually validated my change in light and dark mode.
  • I have used gap or flexbox properties for layout instead of margin whenever possible.

If new component:

  • I am exporting any new components or constants:
    • from the index.js in the component directory.
    • from the index.js in the root (either packages/dialtone-vue2 or packages/dialtone-vue3).
  • I have added the styles for the new component to the packages/dialtone-css package.
  • I have created a page for the new component on the documentation site in apps/dialtone-documentation.
  • I have added the new component to common/components_list.js
  • I have created a component story in storybook
  • I have created story / stories for any relevant component variants in storybook
  • I have created a docs page for the component in storybook.
  • I have checked that changing all props/slots via the UI in storybook works as expected.

๐Ÿ”ฎ Next Steps

๐Ÿ“ท Screenshots / GIFs

๐Ÿ”— Sources

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

This pull request updates documentation for several components, moving detailed information from Storybook to the main documentation site. Key changes include:

  • Updated Popover component documentation with new features and accessibility information
  • Enhanced Presence component documentation with crucial accessibility details
  • Improved Radio and Radio Group documentation with Vue component examples and accessibility information
  • Simplified MDX files for Popover, Presence, Radio, and Radio Group components, redirecting to main docs
  • Added 'code-block-style' rule exception in .markdownlint.json for more flexible code block formatting

These changes aim to centralize documentation, improve consistency, and enhance accessibility guidance across the Dialtone design system.

14 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants